home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1998 March / EnigmA AMIGA RUN 25 (1997)(G.R. Edizioni)(IT)[!][issue 1998-03].iso / recent2 / stripcodes.lha / stripcodes / StripCodes.doc
Text File  |  1998-01-14  |  5KB  |  156 lines
  1. ****************************  StripCodes V1.9  ***************************
  2.  
  3.                         Revision date: 16 Dec 1997
  4.  
  5.                           ©1996-1997 Tim Jackson
  6.  
  7.  
  8. At-A-Glance Guide to Changes since V1.8
  9. ---------------------------------------
  10. - NEW FEATURE!  Can now *replace* a particular code with another instead
  11.   of stripping it.
  12. - No longer crashes if you break using Ctrl-C.  Sorry about that bug.
  13. - Giving the code to strip as an argument is now mandatory (before, code 0
  14.   was assumed if none was given).
  15. - The progress indicator returns! :)
  16.  
  17.  
  18. What is StripCodes?
  19. -------------------
  20. StripCodes is a simple little program which will strip any occurrences of a
  21. given ASCII code from any file.
  22.  
  23. It will also replace any occurrences of a given ASCII code with another
  24. given ASCII code.
  25.  
  26.  
  27. What do I need to run it?
  28. -------------------------
  29. Any Amiga with WB2.04+.
  30.  
  31. Enough memory to load the file you wish to process in its entirety.  If
  32. anyone has any problems with this then I can easily add an option which
  33. will allow files larger than the available memory to be processed.
  34.  
  35.  
  36. What files should I have?
  37. -------------------------
  38. In this distribution, there should be the following files:
  39.  
  40. StripCodes
  41. StripCodes.doc
  42. StripCodes.doc.info
  43.  
  44.  
  45. Copyright & Distribution
  46. ------------------------
  47. StripCodes is FREEWARE.  That means you can copy it and freely distribute
  48. it (including uploading to a BBS/Aminet etc.), as long as:
  49.  
  50. - You don't charge anything for it (except a nominal charge for disk and
  51.   copying)
  52. - You include all the files listed above in any distribution.
  53. - You don't modify any files.
  54.  
  55. (For inclusion on compilation CDs or magazine coverdisks/cover CDs, contact
  56. me.  Any other queries, contact me.  No permission is necessary for
  57. inclusion on Aminet or Fred Fish CDs.)
  58.  
  59. The copyright of the program remains with me at all times.
  60.  
  61.  
  62. Disclaimer
  63. ----------
  64. You use this program entirely at your own risk.  The author will accept no
  65. responsibility whatsoever for any loss or damage caused by this program
  66. including but not limited to loss of or damage to data.
  67.  
  68.  
  69. Why write StripCodes?
  70. ---------------------
  71. I needed a program simply to remove some rogue ASCII characters which a
  72. program I was using was inserting into files.  Initially StripCodes just
  73. removed code 15s (the one I needed to remove) but I changed it to make it
  74. more useful.
  75.  
  76.  
  77. OK, what does it do exactly?
  78. ----------------------------
  79. In it's usual form, it takes an input file, scans through it and writes it
  80. to an output file, minus any occurrences of the code you wanted to remove.
  81.  
  82. In the new extended form, you can also add a code to *replace* the code
  83. you have already specified.
  84.  
  85.  
  86. How do I use it?
  87. ----------------
  88. Simply call it from the CLI using:
  89.  
  90. StripCodes <input file> <output file> <code to act on> [optional code to
  91. replace with]
  92.  
  93. Examples:
  94.  
  95. "StripCodes File1 File2 65"
  96.  
  97. Strip all occurrences of ASCII code 65 from File1 and save the result to
  98. File2
  99.  
  100. "StripCodes File1 File2 10 13"
  101. Replace all occurences of ASCII code 10 with code 13.
  102.  
  103.  
  104. Future Improvements
  105. -------------------
  106. I can't think of anything useful I can add to this program, it's so
  107. simple. But if you can, do let me know!
  108.  
  109. A further increase in speed would also be nice; I don't really have any
  110. ideas for this at the moment, but I'll have a think.
  111.  
  112.  
  113. Known Bugs
  114. ----------
  115. Bugs?
  116.  
  117.  
  118. Version History
  119. ---------------
  120. V1.00 Original version.
  121. V1.01 Read input file but had bug.
  122. V1.02 Read input file correctly.
  123. V1.03 Strips code 15s correctly.
  124. V1.04 Now strips any codes and accepts output file.
  125. V1.05 Now includes Control-C detection & better argument handling. Corrected
  126.       bug in argument handling.
  127. V1.06 Added bad code checking & bug in output file handling removed.
  128. V1.07 Now gives output information - FIRST PUBLIC RELEASE.
  129. V1.7  Same as V1.07 but with Style Guide compliant version number :)
  130. V1.8  Bit of an overhaul. No more null bytes on end of output files.
  131.       Progress indicator removed (for the time being).
  132.       ~100% speed increase.
  133.       Minor bug in error handling corrected.
  134. V1.9  No longer crashes on a Ctrl-C.
  135.       Added option to replace codes instead of stripping them. (Thanks
  136.       to Timo Ronkko for this suggestion)
  137.       Argument of code to strip now mandatory.
  138.       Progress indicator put back in (and no longer causes truncation of
  139.       output files!)
  140.  
  141.  
  142. » Contact me! «
  143. ---------------
  144. If you've found StripCodes useful, TELL ME ABOUT IT!  The program is
  145. freeware; there is nothing to be paid but I'd like to hear from you anyway.
  146.  
  147. Any bug reports or suggestions for improvement should also be sent to the
  148. below e-mail address:
  149.  
  150. tim_jackson@bigfoot.com
  151.  
  152. I occasionally use IRC and when I do, my usual nick is Arcline.  I tend to
  153. hang around on IRCnet.  A list of IRCnet servers can be found at:
  154.  
  155. http://www.irchelp.org/irchelp/networks/servers/ircnet.html
  156.